<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>Class: ActiveRecord::Base</title>

<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
</script>

<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>


<body id="top" class="class">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="../index.html">Home</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>lib/vbulletin_rails/core_ext.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    <nav id="parent-class-section" class="section">
  <h3 class="section-header">Parent</h3>
  
  <p class="link">Object
  
</nav>

    
    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li><a href="#method-c-database_configuration">::database_configuration</a>
    
    <li><a href="#method-c-db_env">::db_env</a>
    
    <li><a href="#method-c-establish_vbulletin_connection">::establish_vbulletin_connection</a>
    
    <li><a href="#method-c-get_vbulletin_prefix">::get_vbulletin_prefix</a>
    
    <li><a href="#method-c-include_vbulletin">::include_vbulletin</a>
    
    <li><a href="#method-c-set_column_names_for_vbulletin">::set_column_names_for_vbulletin</a>
    
    <li><a href="#method-i-add_vbulletin">#add_vbulletin</a>
    
    <li><a href="#method-i-register_parameter_from_user_model">#register_parameter_from_user_model</a>
    
    <li><a href="#method-i-register_parameters_from_user_model">#register_parameters_from_user_model</a>
    
    <li><a href="#method-i-update_vbulletin">#update_vbulletin</a>
    
    <li><a href="#method-i-validate_vbulletin">#validate_vbulletin</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="../LICENSE.html">LICENSE</a>
  
    <li class="file"><a href="../TODO.html">TODO</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="../Rails/Application/Configuration.html">Rails::Application::Configuration</a>
  
    <li><a href="../VBulletinRails.html">VBulletinRails</a>
  
    <li><a href="../VBulletinRails/Session.html">VBulletinRails::Session</a>
  
    <li><a href="../VBulletinRails/User.html">VBulletinRails::User</a>
  
    <li><a href="../ActionController/Base.html">ActionController::Base</a>
  
    <li><a href="../ActiveRecord/Base.html">ActiveRecord::Base</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="class">class ActiveRecord::Base</h1>

  <div id="description" class="description">
    
<p><a href="Base.html">ActiveRecord::Base</a> extension for vbulletin methods</p>

  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    <!-- Methods -->
    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Class Methods</h3>

    
      <div id="method-c-include_vbulletin" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">include_vbulletin</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Method used in user processing model to include vbulletin support</p>

<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">User</span> <span class="ruby-operator">&lt;</span> <span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>
  <span class="ruby-identifier">include_vbulletin</span>
<span class="ruby-keyword">end</span>
</pre>

<p>With this method included, two hooks on User are added:</p>
<ul><li>
<p>When user is created - additional VBulletin account corresponding to user
email and password is created, see: <a
href="Base.html#method-i-add_vbulletin">#add_vbulletin</a></p>
</li><li>
<p>When user is updated - corresponding VBulletin password is updated, see: <a
href="Base.html#method-i-update_vbulletin">#update_vbulletin</a></p>
</li><li>
<p>When user is validated - corresponding VBulletin object is validated as
well, see: <a
href="Base.html#method-i-validate_vbulletin">#validate_vbulletin</a></p>
</li></ul>
          

          
          <div class="method-source-code" id="include_vbulletin-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">include_vbulletin</span>
  <span class="ruby-identifier">before_validation</span> <span class="ruby-value">:validate_vbulletin</span>
  <span class="ruby-identifier">before_create</span> <span class="ruby-value">:add_vbulletin</span>
  <span class="ruby-identifier">after_update</span> <span class="ruby-value">:update_vbulletin</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- include_vbulletin-source -->
          
        </div>

        

        
      </div><!-- include_vbulletin-method -->

    
      <div id="method-c-set_column_names_for_vbulletin" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">set_column_names_for_vbulletin</span><span
            class="method-args">(options)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Method used in user processing model to overwrite default column names.
Normally <a href="../VBulletinRails.html">VBulletinRails</a> assumes, that
User model contains columns with names ‘email’, ‘password’ and (optional)
‘username’. If you want to overwrite this, use this method as follows:</p>

<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">User</span> <span class="ruby-operator">&lt;</span> <span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>
  <span class="ruby-identifier">set_column_names_for_vbulletin</span> :<span class="ruby-identifier">email</span> =<span class="ruby-operator">&gt;</span> :<span class="ruby-identifier">my_email_column_name</span>, :<span class="ruby-identifier">password</span> =<span class="ruby-operator">&gt;</span> :<span class="ruby-identifier">my_password_column_name</span>, :<span class="ruby-identifier">username</span> =<span class="ruby-operator">&gt;</span> :<span class="ruby-identifier">my_login_column_name</span>
<span class="ruby-keyword">end</span>
</pre>
          

          
          <div class="method-source-code" id="set_column_names_for_vbulletin-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">set_column_names_for_vbulletin</span> <span class="ruby-identifier">options</span>
  <span class="ruby-identifier">@@vbulletin_column_names</span> = {<span class="ruby-value">:email</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:email</span>, <span class="ruby-value">:password</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:password</span>, <span class="ruby-value">:username</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">:username</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>.<span class="ruby-identifier">symbolize_keys</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- set_column_names_for_vbulletin-source -->
          
        </div>

        

        
      </div><!-- set_column_names_for_vbulletin-method -->

    
    </section><!-- public-class-method-details -->
  
     <section id="private-class-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Private Class Methods</h3>

    
      <div id="method-c-database_configuration" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">database_configuration</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Get database configuration options</p>
          

          
          <div class="method-source-code" id="database_configuration-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">database_configuration</span>
  <span class="ruby-keyword">begin</span>
    <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">database_configuration</span>
  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>
    <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>, <span class="ruby-string">'config'</span>, <span class="ruby-string">'database.yml'</span>)) <span class="ruby-operator">?</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>, <span class="ruby-string">'config'</span>, <span class="ruby-string">'database.yml'</span>) <span class="ruby-operator">:</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>, <span class="ruby-string">'test'</span>, <span class="ruby-string">'dummy'</span>, <span class="ruby-string">'config'</span>, <span class="ruby-string">'database.yml'</span>))
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- database_configuration-source -->
          
        </div>

        

        
      </div><!-- database_configuration-method -->

    
      <div id="method-c-db_env" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">db_env</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Get valid VBulettin database.yml section</p>
          

          
          <div class="method-source-code" id="db_env-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">db_env</span>
  <span class="ruby-identifier">base_env</span> = (<span class="ruby-keyword">defined?</span>(<span class="ruby-constant">Rails</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">env</span> <span class="ruby-operator">:</span> <span class="ruby-string">'test'</span>)
  <span class="ruby-identifier">database_configuration</span>[<span class="ruby-string">'vbulletin_'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">base_env</span>] <span class="ruby-operator">?</span> <span class="ruby-string">'vbulletin_'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">base_env</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">base_env</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- db_env-source -->
          
        </div>

        

        
      </div><!-- db_env-method -->

    
      <div id="method-c-establish_vbulletin_connection" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">establish_vbulletin_connection</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Sets connection to VBulletin database. If
<code>vbulletin_&lt;environemt&gt;</code> specified in
<code>database.yml</code> file, it connets to that database instead of
normal database.</p>

<pre># database.yml
# Sets VBulletin connetion to another database located in external.com, and assumes that all VBulletin tables have vb_ prefix.
development:
  adapter: mysql2
  username: user
  password: pass
  host: localhost
vbulletin_development:
  adapter: mysql2
  username: vb
  password: vbpass
  host: external.com
  prefix: vb_</pre>
          

          
          <div class="method-source-code" id="establish_vbulletin_connection-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">establish_vbulletin_connection</span>
  <span class="ruby-identifier">establish_connection</span>(<span class="ruby-identifier">database_configuration</span>[<span class="ruby-identifier">db_env</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">db_env</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">/vbulletin_/</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- establish_vbulletin_connection-source -->
          
        </div>

        

        
      </div><!-- establish_vbulletin_connection-method -->

    
      <div id="method-c-get_vbulletin_prefix" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">get_vbulletin_prefix</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Returns proper prefix for VBulletin tables</p>
          

          
          <div class="method-source-code" id="get_vbulletin_prefix-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">get_vbulletin_prefix</span>
  ((<span class="ruby-identifier">database_configuration</span>[<span class="ruby-identifier">db_env</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">database_configuration</span>[<span class="ruby-identifier">db_env</span>][<span class="ruby-string">'prefix'</span>]) <span class="ruby-operator">?</span> <span class="ruby-identifier">database_configuration</span>[<span class="ruby-identifier">db_env</span>][<span class="ruby-string">'prefix'</span>] <span class="ruby-operator">:</span> <span class="ruby-string">''</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- get_vbulletin_prefix-source -->
          
        </div>

        

        
      </div><!-- get_vbulletin_prefix-method -->

    
    </section><!-- private-class-method-details -->
  
     <section id="private-instance-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Private Instance Methods</h3>

    
      <div id="method-i-add_vbulletin" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">add_vbulletin</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Filter launched <code>before_create</code>, it registers given user in
VBulletin forum</p>
          

          
          <div class="method-source-code" id="add_vbulletin-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_vbulletin</span>
  <span class="ruby-constant">VBulletinRails</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">register</span>(<span class="ruby-identifier">register_parameters_from_user_model</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- add_vbulletin-source -->
          
        </div>

        

        
      </div><!-- add_vbulletin-method -->

    
      <div id="method-i-register_parameter_from_user_model" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">register_parameter_from_user_model</span><span
            class="method-args">(vbulletin_column_name)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Returns VBulletin friendly parameter value</p>
          

          
          <div class="method-source-code" id="register_parameter_from_user_model-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">register_parameter_from_user_model</span>(<span class="ruby-identifier">vbulletin_column_name</span>)
  ((<span class="ruby-keyword">defined?</span>(<span class="ruby-identifier">@@vbulletin_column_names</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">@@vbulletin_column_names</span>[<span class="ruby-identifier">vbulletin_column_name</span>])) <span class="ruby-operator">?</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">@@vbulletin_column_names</span>[<span class="ruby-identifier">vbulletin_column_name</span>]) <span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">vbulletin_column_name</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- register_parameter_from_user_model-source -->
          
        </div>

        

        
      </div><!-- register_parameter_from_user_model-method -->

    
      <div id="method-i-register_parameters_from_user_model" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">register_parameters_from_user_model</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Returns hash of parameters ready to pass to <a
href="../VBulletinRails/User.html">VBulletinRails::User</a> constructor</p>
          

          
          <div class="method-source-code" id="register_parameters_from_user_model-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">register_parameters_from_user_model</span>
  <span class="ruby-identifier">register_parameters</span> = [<span class="ruby-value">:email</span>, <span class="ruby-value">:password</span>, <span class="ruby-value">:username</span>].<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">vbulletin_column_name</span><span class="ruby-operator">|</span>
    [<span class="ruby-identifier">vbulletin_column_name</span>, <span class="ruby-identifier">register_parameter_from_user_model</span>(<span class="ruby-identifier">vbulletin_column_name</span>)]
  <span class="ruby-keyword">end</span>
  <span class="ruby-constant">Hash</span>[*<span class="ruby-identifier">register_parameters</span>.<span class="ruby-identifier">flatten</span>]
<span class="ruby-keyword">end</span></pre>
          </div><!-- register_parameters_from_user_model-source -->
          
        </div>

        

        
      </div><!-- register_parameters_from_user_model-method -->

    
      <div id="method-i-update_vbulletin" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">update_vbulletin</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Filter launched <code>after_update</code>, updates VBulletin user password</p>
          

          
          <div class="method-source-code" id="update_vbulletin-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_vbulletin</span>
  <span class="ruby-identifier">vb_user</span> = <span class="ruby-constant">VBulletinRails</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">register_parameter_from_user_model</span>(<span class="ruby-value">:email</span>))
  <span class="ruby-identifier">vb_user</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-value">:password</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">register_parameter_from_user_model</span>(<span class="ruby-value">:password</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- update_vbulletin-source -->
          
        </div>

        

        
      </div><!-- update_vbulletin-method -->

    
      <div id="method-i-validate_vbulletin" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">validate_vbulletin</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Filter launched <code>before_validation</code>, won’t allow using it model
to validate unless VBulletin validates properly</p>
          

          
          <div class="method-source-code" id="validate_vbulletin-source">
            <pre><span class="ruby-comment"># File lib/vbulletin_rails/core_ext.rb, line 47</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_vbulletin</span>
  <span class="ruby-identifier">vb_user</span> = <span class="ruby-constant">VBulletinRails</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">register_parameter_from_user_model</span>(<span class="ruby-value">:email</span>))
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">vb_user</span>
    <span class="ruby-identifier">vb_user</span> = <span class="ruby-constant">VBulletinRails</span><span class="ruby-operator">::</span><span class="ruby-constant">User</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">register_parameters_from_user_model</span>) 
    <span class="ruby-keyword">unless</span> <span class="ruby-identifier">vb_user</span>.<span class="ruby-identifier">valid?</span>
      <span class="ruby-identifier">vb_user</span>.<span class="ruby-identifier">errors</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">error</span>, <span class="ruby-identifier">message</span><span class="ruby-operator">|</span>
        <span class="ruby-keyword">self</span>.<span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-string">'vbulletin_'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">error</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">message</span>)
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- validate_vbulletin-source -->
          
        </div>

        

        
      </div><!-- validate_vbulletin-method -->

    
    </section><!-- private-instance-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.11.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>

